﻿' LibWowArmory
' by Ronald M. Clifford (roncli@roncli.com)
' ItemTooltip classes contributed by Lukan Schwigtenberg (sepai69@gmail.com)
'
' This source code is released under the GNU Library General Public License (LGPL) Version 2.1.

Namespace roncliProductions.LibWowArmory.Item.Tooltip

    ''' <summary>
    ''' A class that encapsulates spell information
    ''' </summary>
    ''' <remarks></remarks>
    Public Class SpellData

        ''' <summary>
        ''' The type of trigger for the spell
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public Property Trigger As Enums.SpellTriggerType

        ''' <summary>
        ''' The description of the spell
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public Property Description As String

        ''' <summary>
        ''' The number of charges the item has
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks>Returns 0 if the item does not consume charges</remarks>
        Public Property Charges As Integer

        ''' <summary>
        ''' A constructor to create new spell information
        ''' </summary>
        ''' <param name="stTrigger"></param>
        ''' <param name="strDesc"></param>
        ''' <param name="intCharges"></param>
        ''' <remarks></remarks>
        Public Sub New(ByVal stTrigger As Enums.SpellTriggerType, ByVal strDesc As String, ByVal intCharges As Integer)
            Trigger = stTrigger
            Description = strDesc
            Charges = intCharges
        End Sub

    End Class

End Namespace
